Skip to content

CIVIMM-462: Copy payment_instrument_id to instalments#13

Merged
erawat merged 2 commits intomasterfrom
CIVIMM-462-add-payment-instrument-id
Feb 17, 2026
Merged

CIVIMM-462: Copy payment_instrument_id to instalments#13
erawat merged 2 commits intomasterfrom
CIVIMM-462-add-payment-instrument-id

Conversation

@erawat
Copy link
Member

@erawat erawat commented Feb 12, 2026

Overview

Ensures instalment contributions inherit the payment method (e.g., Credit Card, Direct Debit) from their parent recurring contribution when generated by Job 1.

Before

Instalment contributions created by the Generate Instalments job did not have a payment_instrument_id, even when the parent recurring contribution had one set.

After

Instalment contributions now inherit payment_instrument_id from the parent recurring contribution, matching the Recurring-5 specification requirements.

Technical Details

  • Added paymentInstrumentId property to RecurringContributionDTO
  • Updated getDueRecurringContributions() query to select payment_instrument_id
  • Updated createInstalment() to copy payment_instrument_id when present

Core overrides

None.

Comments

This completes the Job 1 (Generate Instalments) implementation per the Recurring-5 spec.

@erawat
CIVIMM-462: Copy payment_instrument_id from recurring contribution to…
433e1d8 
… instalment

Add payment_instrument_id field to RecurringContributionDTO and copy it
when creating instalment contributions. This ensures instalments inherit
the payment method from the parent recurring contribution as specified
in the Recurring-5 requirements.
@gemini-code-assist
Copy link

gemini-code-assist bot commented Feb 12, 2026

Summary of Changes

Hello @erawat, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves an issue where instalment contributions generated by Job 1 were not inheriting the payment instrument ID from their parent recurring contributions. The changes ensure that these generated instalments now correctly carry the associated payment method information, thereby aligning with the Recurring-5 specification requirements.

Highlights

  • DTO Enhancement: The RecurringContributionDTO has been updated to include a paymentInstrumentId property, allowing it to carry payment method information.
  • Data Retrieval: The getDueRecurringContributions method now explicitly selects the payment_instrument_id from the database when fetching recurring contributions.
  • Instalment Inheritance: The createInstalment method has been modified to ensure that newly generated instalment contributions inherit the payment_instrument_id from their parent recurring contribution, if available.
Changelog
  • Civi/Paymentprocessingcore/DTO/RecurringContributionDTO.php
    • Added a new private property $paymentInstrumentId to store the payment instrument ID.
    • Updated the class constructor to accept paymentInstrumentId as a parameter.
    • Modified the fromApiResult factory method to parse and set the payment_instrument_id from API results.
    • Introduced a public getter method getPaymentInstrumentId() to access the new property.
  • Civi/Paymentprocessingcore/Service/InstalmentGenerationService.php
    • Modified the getDueRecurringContributions method to include payment_instrument_id in the list of selected fields from the database.
    • Updated the createInstalment method to conditionally add the payment_instrument_id to the new instalment if it is present in the parent recurring contribution DTO.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist[bot]
gemini-code-assist bot reviewed Feb 12, 2026
View reviewed changes
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request correctly adds support for copying the payment_instrument_id from a recurring contribution to its generated instalments. The changes in the RecurringContributionDTO and InstalmentGenerationService are logical and consistent with the existing codebase. However, I've identified a potential issue in the DTO data validation that could be improved for robustness, aligning with best practices for handling critical data. Additionally, as per the repository's style guide, the changes are missing corresponding unit tests to verify the new functionality.

@erawat erawat merged commit 3d89a9c into master Feb 17, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shahrukh-compuco shahrukh-compuco shahrukh-compuco approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@erawat @shahrukh-compuco